Skip to main content

Compare short term

Average forcasted airbnb and traditional property income for the next year.

Paramaters​

address - optional​

Address of property

city - optional​

City of property

state - optional​

State of property

zipcode - required​

Zipcode of property

Code Example​

GET - https://api.particlespace.com/api/v1/property/compare/shortterm
var axios = require('axios');
const BEARER_TOKEN = 'SET_ME';
var config = {
  method: 'get',
  url: 'https://api.particlespace.com/api/v1/property/compare/shortterm?city=kansas%20city&state=mo&zipcode=64114',
  headers: {
    'Authorization': 'Bearer ' + BEARER_TOKEN
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Response​

This request will return the following:

{
  "airbnb": {
    "avg_night": 81,
    "avg_ocupy_rate": 0,
    "forcasted_income": {
      "1year_income_avg_ocupy": 8573,
      "1year_income_50_ocupy": 14782,
      "1year_income_75_ocupy": 22173
    }
  },
  "traditional": {
    "avg_month_rent": 1000,
    "1year_income_traditional": 12000
  }
}